<!DOCTYPE html>
<html lang="en">
  <head>
    <title>PolarOfflineRecordingApi Protocol Reference</title>
    <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="../css/highlight.css" />
    <meta charset='utf-8'>
    <script src="../js/jquery.min.js" defer></script>
    <script src="../js/jazzy.js" defer></script>
    
    <script src="../js/lunr.min.js" defer></script>
    <script src="../js/typeahead.jquery.js" defer></script>
    <script src="../js/jazzy.search.js" defer></script>
  </head>
  <body>
    <a name="//apple_ref/swift/Protocol/PolarOfflineRecordingApi" class="dashAnchor"></a>
    <a title="PolarOfflineRecordingApi Protocol Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="../index.html"> Docs</a> (100% documented)</p>
        <div class="header-right">
          <form role="search" action="../search.json">
            <input type="text" placeholder="Search documentation" data-typeahead>
          </form>
        </div>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="../index.html">Index</a>
        <img id="carat" src="../img/carat.png" alt=""/>
        <a href="../Protocols.html">Protocols</a>
        <img id="carat" src="../img/carat.png" alt=""/>
        PolarBleSdk.PolarOfflineRecordingApi Protocol Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="../Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Classes/BleHtsClient.html">BleHtsClient</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/BleHtsClient/TemperatureMeasurement.html">– TemperatureMeasurement</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/HealthThermometer.html">HealthThermometer</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/PolarSleepData.html">PolarSleepData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Classes/PolarSleepData.html#/s:11PolarBleSdk0A9SleepDataC0aD14AnalysisResultV">– PolarSleepAnalysisResult</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Enums/OhrDataType.html">OhrDataType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/PolarBleSdkFeature.html">PolarBleSdkFeature</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/PolarErrors.html">PolarErrors</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/PolarOfflineRecordingData.html">PolarOfflineRecordingData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/PolarOfflineRecordingTriggerMode.html">PolarOfflineRecordingTriggerMode</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/PpgDataType.html">PpgDataType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/RecordingInterval.html">RecordingInterval</a>
              </li>
              <li class="nav-group-task">
                <a href="../Enums/SampleType.html">SampleType</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Extensions.html#/c:@M@PolarBleSdk@objc(cs)PolarBleApiImpl">PolarBleApiImpl</a>
              </li>
              <li class="nav-group-task">
                <a href="../Extensions/PrimitiveSequence.html">PrimitiveSequence</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Protocols/PolarActivityApi.html">PolarActivityApi</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApi.html">PolarBleApi</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiDeviceHrObserver.html">PolarBleApiDeviceHrObserver</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiDeviceInfoObserver.html">PolarBleApiDeviceInfoObserver</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiLogger.html">PolarBleApiLogger</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiObserver.html">PolarBleApiObserver</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiPowerStateObserver.html">PolarBleApiPowerStateObserver</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarBleApiSdkModeFeatureObserver.html">PolarBleApiSdkModeFeatureObserver</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarH10OfflineExerciseApi.html">PolarH10OfflineExerciseApi</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarOfflineRecordingApi.html">PolarOfflineRecordingApi</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarOnlineStreamingApi.html">PolarOnlineStreamingApi</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarSdkModeApi.html">PolarSdkModeApi</a>
              </li>
              <li class="nav-group-task">
                <a href="../Protocols/PolarSleepApi.html">PolarSleepApi</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Structs/LedConfig.html">LedConfig</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarActiveTime.html">PolarActiveTime</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarActiveTimeData.html">PolarActiveTimeData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarDiskSpaceData.html">PolarDiskSpaceData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarDistanceData.html">PolarDistanceData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarFirstTimeUseConfig.html">PolarFirstTimeUseConfig</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarFirstTimeUseConfig/Gender.html">– Gender</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarFirstTimeUseConfig/TrainingBackground.html">– TrainingBackground</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarOfflineRecordingTrigger.html">PolarOfflineRecordingTrigger</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarSensorSetting.html">PolarSensorSetting</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarSensorSetting/SettingType.html">– SettingType</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/PolarStepsData.html">PolarStepsData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Structs/SDLogConfig.html">SDLogConfig</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="../Typealiases.html">Type Aliases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A7AccDataa">PolarAccData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A10DeviceInfoa">PolarDeviceInfo</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A7EcgDataa">PolarEcgData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A12ExerciseDataa">PolarExerciseData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A13ExerciseEntrya">PolarExerciseEntry</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A8GyroDataa">PolarGyroData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A15HrBroadcastDataa">PolarHrBroadcastData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A6HrDataa">PolarHrData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A16MagnetometerDataa">PolarMagnetometerData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A7OhrDataa">PolarOhrData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A7PpgDataa">PolarPpgData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A7PpiDataa">PolarPpiData</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A15RecordingStatusa">PolarRecordingStatus</a>
              </li>
              <li class="nav-group-task">
                <a href="../Typealiases.html#/s:11PolarBleSdk0A15TemperatureDataa">PolarTemperatureData</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            <h1>PolarOfflineRecordingApi</h1>
              <div class="declaration">
                <div class="language">
                  
                  <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">protocol</span> <span class="kt">PolarOfflineRecordingApi</span></code></pre>

                </div>
              </div>
            <p>Offline recording API.</p>

<p>Offline recording makes it possible to record <code>PolarBleApi.PolarDeviceDataType</code> data to device memory.
With Offline recording the Polar device and phone don&rsquo;t need to be connected all the time, as offline recording continues in Polar device even the BLE disconnects.</p>

<p>Offline records saved into the device can be encrypted. The  <code><a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a></code> is provided for
 <code>startOfflineRecording</code> and <code>setOfflineRecordingTrigger</code> when encryption is wanted.
 The <code><a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a></code> with same key must be provided in <code>getOfflineRecord</code> to correctly
 decrypt the data in the device.</p>

<p>Requires feature <code><a href="../Enums/PolarBleSdkFeature.html#/s:11PolarBleSdk0abC7FeatureO31feature_polar_offline_recordingyA2CmF">PolarBleSdkFeature.feature_polar_offline_recording</a></code></p>

<p>Note, offline recording is supported in Polar Verity Sense device (starting from firmware version 2.1.0)</p>

          </section>
          <section class="section task-group-section">
            <div class="task-group">
              <ul>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP012getAvailabledE9DataTypesy7RxSwift17PrimitiveSequenceVyAE11SingleTraitOShyAA0a6DeviceI4TypeOGGSSF"></a>
                    <a name="//apple_ref/swift/Method/getAvailableOfflineRecordingDataTypes(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP012getAvailabledE9DataTypesy7RxSwift17PrimitiveSequenceVyAE11SingleTraitOShyAA0a6DeviceI4TypeOGGSSF">getAvailableOfflineRecordingDataTypes(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Get the data types available in this device for offline recording</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getAvailableOfflineRecordingDataTypes</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="kt">Set</span><span class="o">&lt;</span><span class="kt"><a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a></span><span class="o">&gt;&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Single stream

<ul>
<li>success:  set of available offline recording data types in this device</li>
<li>onError: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP07requestdE8Settings_7feature7RxSwift17PrimitiveSequenceVyAF11SingleTraitOAA0A13SensorSettingVGSS_AA0A14DeviceDataTypeOtF"></a>
                    <a name="//apple_ref/swift/Method/requestOfflineRecordingSettings(_:feature:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP07requestdE8Settings_7feature7RxSwift17PrimitiveSequenceVyAF11SingleTraitOAA0A13SensorSettingVGSS_AA0A14DeviceDataTypeOtF">requestOfflineRecordingSettings(_:<wbr>feature:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Request the offline recording settings available in current operation mode. This request shall be used before the offline recording is started
 to decide currently available settings. The available settings depend on the state of the device.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">requestOfflineRecordingSettings</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">feature</span><span class="p">:</span> <span class="kt"><a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/PolarSensorSetting.html">PolarSensorSetting</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Single stream

<ul>
<li>success: once after settings received from device</li>
<li>onError: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP011requestFulldE8Settings_7feature7RxSwift17PrimitiveSequenceVyAF11SingleTraitOAA0A13SensorSettingVGSS_AA0A14DeviceDataTypeOtF"></a>
                    <a name="//apple_ref/swift/Method/requestFullOfflineRecordingSettings(_:feature:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP011requestFulldE8Settings_7feature7RxSwift17PrimitiveSequenceVyAF11SingleTraitOAA0A13SensorSettingVGSS_AA0A14DeviceDataTypeOtF">requestFullOfflineRecordingSettings(_:<wbr>feature:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Request all the settings available in the device. The request returns the all capabilities of the requested streaming feature not limited by the current operation mode.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">requestFullOfflineRecordingSettings</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">feature</span><span class="p">:</span> <span class="kt"><a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/PolarSensorSetting.html">PolarSensorSetting</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Single stream

<ul>
<li>success: once after settings received from device</li>
<li>onError: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP03getdE6Statusy7RxSwift17PrimitiveSequenceVyAE11SingleTraitOSDyAA0A14DeviceDataTypeOSbGGSSF"></a>
                    <a name="//apple_ref/swift/Method/getOfflineRecordingStatus(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP03getdE6Statusy7RxSwift17PrimitiveSequenceVyAE11SingleTraitOSDyAA0A14DeviceDataTypeOSbGGSSF">getOfflineRecordingStatus(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Get status of offline recordings.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getOfflineRecordingStatus</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="p">[</span><span class="kt"><a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a></span> <span class="p">:</span> <span class="kt">Bool</span><span class="p">]</span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Single stream

<ul>
<li>success: the dictionary indicating the offline recording status, if the value in dictionary is true the offline recording is currently recording</li>
<li>error: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP04listD10Recordingsy7RxSwift10ObservableCyAA0adE5EntryVGSSF"></a>
                    <a name="//apple_ref/swift/Method/listOfflineRecordings(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP04listD10Recordingsy7RxSwift10ObservableCyAA0adE5EntryVGSSF">listOfflineRecordings(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>List offline recordings stored in the device.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">listOfflineRecordings</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Observable</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>next :  the found offline recording entry</li>
<li>completed: the listing completed</li>
<li>error: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP03getD6Record_5entry6secret7RxSwift17PrimitiveSequenceVyAG11SingleTraitOAA0adE4DataOGSS_AA0adE5EntryVAA0aE6SecretVSgtF"></a>
                    <a name="//apple_ref/swift/Method/getOfflineRecord(_:entry:secret:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP03getD6Record_5entry6secret7RxSwift17PrimitiveSequenceVyAG11SingleTraitOAA0adE4DataOGSS_AA0adE5EntryVAA0aE6SecretVSgtF">getOfflineRecord(_:<wbr>entry:<wbr>secret:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Fetch recording from the  device.</p>

<p>Note, the fetching of the recording may take several seconds if the recording is big.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getOfflineRecord</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">entry</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a></span><span class="p">,</span> <span class="nv">secret</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="kt"><a href="../Enums/PolarOfflineRecordingData.html">PolarOfflineRecordingData</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>entry</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The offline recording to be fetched</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>secret</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>If the secret is provided in <code>startOfflineRecording</code> or <code>setOfflineRecordingTrigger</code> then the same secret must be provided when fetching the offline record</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Single

<ul>
<li>success :  the offline recording data</li>
<li>error: fetch recording request failed. see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP09listSplitD10Recordingsy7RxSwift10ObservableCyAA0adE5EntryVGSSF"></a>
                    <a name="//apple_ref/swift/Method/listSplitOfflineRecordings(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP09listSplitD10Recordingsy7RxSwift10ObservableCyAA0adE5EntryVGSSF">listSplitOfflineRecordings(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>List split offline recordings stored in the device.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">listSplitOfflineRecordings</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Observable</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>next :  the found split offline recording entry</li>
<li>completed: the listing completed</li>
<li>error: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP08getSplitD6Record_5entry6secret7RxSwift17PrimitiveSequenceVyAG11SingleTraitOAA0adE4DataOGSS_AA0adE5EntryVAA0aE6SecretVSgtF"></a>
                    <a name="//apple_ref/swift/Method/getSplitOfflineRecord(_:entry:secret:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP08getSplitD6Record_5entry6secret7RxSwift17PrimitiveSequenceVyAG11SingleTraitOAA0adE4DataOGSS_AA0adE5EntryVAA0aE6SecretVSgtF">getSplitOfflineRecord(_:<wbr>entry:<wbr>secret:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Fetch split recording from the device.</p>

<p>Note, the fetching of the recording may take several seconds if the recording is big.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getSplitOfflineRecord</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">entry</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a></span><span class="p">,</span> <span class="nv">secret</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="kt"><a href="../Enums/PolarOfflineRecordingData.html">PolarOfflineRecordingData</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>entry</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>The split offline recording to be fetched</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>secret</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>If the secret is provided in <code>startOfflineRecording</code> or <code>setOfflineRecordingTrigger</code> then the same secret must be provided when fetching the offline record</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Single

<ul>
<li>success :  the offline recording data</li>
<li>error: fetch recording request failed. see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP06removeD6Record_5entry7RxSwift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_AA0adE5EntryVtF"></a>
                    <a name="//apple_ref/swift/Method/removeOfflineRecord(_:entry:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP06removeD6Record_5entry7RxSwift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_AA0adE5EntryVtF">removeOfflineRecord(_:<wbr>entry:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Removes offline recording from the device</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">removeOfflineRecord</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">entry</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarOfflineRecordingEntry.html">PolarOfflineRecordingEntry</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Completable</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>entry</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>entry to be removed</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>completed :  offline record is removed</li>
<li>error:  offline record removal failed, see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP05startdE0_7feature8settings6secret7RxSwift17PrimitiveSequenceVyAH16CompletableTraitOs5NeverOGSS_AA0A14DeviceDataTypeOAA0A13SensorSettingVSgAA0aE6SecretVSgtF"></a>
                    <a name="//apple_ref/swift/Method/startOfflineRecording(_:feature:settings:secret:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP05startdE0_7feature8settings6secret7RxSwift17PrimitiveSequenceVyAH16CompletableTraitOs5NeverOGSS_AA0A14DeviceDataTypeOAA0A13SensorSettingVSgAA0aE6SecretVSgtF">startOfflineRecording(_:<wbr>feature:<wbr>settings:<wbr>secret:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Start offline recording.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">startOfflineRecording</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">feature</span><span class="p">:</span> <span class="kt"><a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a></span><span class="p">,</span> <span class="nv">settings</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarSensorSetting.html">PolarSensorSetting</a></span><span class="p">?,</span> <span class="nv">secret</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a></span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="kt">Completable</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>feature</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>the feature to be started</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>settings</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>optional settings used for offline recording. <code><a href="../Enums/PolarDeviceDataType.html#/s:11PolarBleSdk0A14DeviceDataTypeO2hryA2CmF">PolarDeviceDataType.hr</a></code> and <code><a href="../Enums/PolarDeviceDataType.html#/s:11PolarBleSdk0A14DeviceDataTypeO3ppiyA2CmF">PolarDeviceDataType.ppi</a></code> do not require settings</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>completed :  offline recording is started successfully</li>
<li>error: see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP04stopdE0_7feature7RxSwift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_AA0A14DeviceDataTypeOtF"></a>
                    <a name="//apple_ref/swift/Method/stopOfflineRecording(_:feature:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP04stopdE0_7feature7RxSwift17PrimitiveSequenceVyAF16CompletableTraitOs5NeverOGSS_AA0A14DeviceDataTypeOtF">stopOfflineRecording(_:<wbr>feature:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Request to stop offline recording.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">stopOfflineRecording</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">feature</span><span class="p">:</span> <span class="kt"><a href="../Enums/PolarDeviceDataType.html">PolarDeviceDataType</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Completable</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>feature</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>the feature to be stopped</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>completed :  offline recording is stop successfully</li>
<li>error: offline recording stop failed. see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP03setdE7Trigger_7trigger6secret7RxSwift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_AA0adeH0VAA0aE6SecretVSgtF"></a>
                    <a name="//apple_ref/swift/Method/setOfflineRecordingTrigger(_:trigger:secret:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP03setdE7Trigger_7trigger6secret7RxSwift17PrimitiveSequenceVyAG16CompletableTraitOs5NeverOGSS_AA0adeH0VAA0aE6SecretVSgtF">setOfflineRecordingTrigger(_:<wbr>trigger:<wbr>secret:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Sets the offline recording triggers for a given Polar device. The offline recording can be started automatically in the device by setting the triggers.
The changes to the trigger settings will take effect on the next device startup.</p>

<p>Automatically started offline recording can be stopped by <code>stopOfflineRecording()</code>. Also if user switches off the device power,
the offline recording is stopped but starts again once power is switched on and the trigger event happens.</p>

<p>Trigger functionality can be disabled by setting <code>PolarOfflineRecordingTriggerMode.TRIGGER_DISABLED</code>, the already running offline
recording is not stopped by disable.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">setOfflineRecordingTrigger</span><span class="p">(</span>
    <span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
    <span class="nv">trigger</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarOfflineRecordingTrigger.html">PolarOfflineRecordingTrigger</a></span><span class="p">,</span>
    <span class="nv">secret</span><span class="p">:</span> <span class="kt"><a href="../Structs/PolarRecordingSecret.html">PolarRecordingSecret</a></span><span class="p">?</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Completable</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>Polar device ID</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>trigger</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>type of trigger to set</p>
                                </div>
                              </td>
                            </tr>
                            <tr>
                              <td>
                                <code>
                                <em>secret</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>optional secret; if provided, the offline recordings are encrypted in the device</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>completed :  the offline recording trigger was set successfully</li>
<li>error: the offline recording trigger was not set successfully; see PolarErrors for possible errors that may be invoked.</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:11PolarBleSdk0A19OfflineRecordingApiP03getdE12TriggerSetupy7RxSwift17PrimitiveSequenceVyAE11SingleTraitOAA0adeH0VGSSF"></a>
                    <a name="//apple_ref/swift/Method/getOfflineRecordingTriggerSetup(_:)" class="dashAnchor"></a>
                    <a class="token" href="#/s:11PolarBleSdk0A19OfflineRecordingApiP03getdE12TriggerSetupy7RxSwift17PrimitiveSequenceVyAE11SingleTraitOAA0adeH0VGSSF">getOfflineRecordingTriggerSetup(_:<wbr>)</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Retrieves the current offline recording trigger setup in the device.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">getOfflineRecordingTriggerSetup</span><span class="p">(</span><span class="n">_</span> <span class="nv">identifier</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Single</span><span class="o">&lt;</span><span class="kt"><a href="../Structs/PolarOfflineRecordingTrigger.html">PolarOfflineRecordingTrigger</a></span><span class="o">&gt;</span></code></pre>

                        </div>
                      </div>
                      <div>
                        <h4>Parameters</h4>
                        <table class="graybox">
                          <tbody>
                            <tr>
                              <td>
                                <code>
                                <em>identifier</em>
                                </code>
                              </td>
                              <td>
                                <div>
                                  <p>polar device id</p>
                                </div>
                              </td>
                            </tr>
                          </tbody>
                        </table>
                      </div>
                      <div>
                        <h4>Return Value</h4>
                        <p>Completable

<ul>
<li>success : the offline recording trigger setup in the device</li>
<li>error: fetching recording trigger setup failed, see <code><a href="../Enums/PolarErrors.html">PolarErrors</a></code> for possible errors invoked</li>
</ul></p>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </section>
        </section>
        <section id="footer">
          <p>&copy; 2024 <a class="link" href="" target="_blank" rel="external noopener"></a>. All rights reserved. (Last updated: 2024-06-20)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external noopener">jazzy ♪♫ v0.15.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external noopener">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</html>
